docs: add more detail to the basic example #1043
Conversation
This change adds more details to the basic example. These details show a new user what to expect from the library.
|
Hi @luin , May I also update the README.md example? |
|
|
||
| // ioredis supports all Redis commands: | ||
| redis.set("foo", "bar"); | ||
| redis.set("foo", "bar"); // returns promise which resolves to string, "OK" |
There was a problem hiding this comment.
I'm considering putting all of this within an async function so that we can async/await some of the commands. What do you think?
There was a problem hiding this comment.
Sorry for the late response! Yes I think that would be helpful but still we should keep some examples for callback-style. I'm going to merge this pr so feel free to create a new pr for the proposal. Thanks again for the contribution!
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed after 7 days if no further activity occurs, but feel free to re-open a closed issue if needed. |
|
|
||
| // ioredis supports all Redis commands: | ||
| redis.set("foo", "bar"); | ||
| redis.set("foo", "bar"); // returns promise which resolves to string, "OK" |
There was a problem hiding this comment.
Sorry for the late response! Yes I think that would be helpful but still we should keep some examples for callback-style. I'm going to merge this pr so feel free to create a new pr for the proposal. Thanks again for the contribution!
|
🎉 This PR is included in version 4.16.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This change only affects the project documentation.
What
This change adds more details to the basic example. These details show a new user what to expect from the library.
Why
As a beginning user of this library, I didn't know what the basic functions returned until I set up a redis server and a notebook to test it out myself. I want to
Notes
I tested the proposed file changes at https://runkit.com/barakplasma/ioredis-basic-operations .